-- Network Working Group B. Stewart
-- Request for Comments: 1658 Xyplex, Inc.
-- Obsoletes: 1316 July 1994
-- Category: Standards Track
--
--
-- Definitions of Managed Objects for Character Stream Devices
-- using SMIv2
--CHARACTER-MIB DEFINITIONS::=BEGINIMPORTSMODULE-IDENTITY,OBJECT-TYPE,NOTIFICATION-TYPE,Counter32,Integer32,Gauge32,TimeTicksFROM SNMPv2-SMI
AutonomousType,InstancePointer
FROM SNMPv2-TC
InterfaceIndexFROM IF-MIB
transmission, mib-2
FROM RFC1213-MIB
MODULE-COMPLIANCE,OBJECT-GROUPFROM SNMPv2-CONF;char MODULE-IDENTITYLAST-UPDATED"9405261700Z"ORGANIZATION"IETF Character MIB Working Group"CONTACT-INFO" Bob Stewart
Postal: Xyplex, Inc.
295 Foster Street
Littleton, MA 01460
Tel: 508-952-4816
Fax: 508-952-4887
E-mail: rlstewart@eng.xyplex.com"DESCRIPTION"The MIB module for character stream devices."::={ mib-2 19}
PortIndex::=TEXTUAL-CONVENTIONDISPLAY-HINT"d"STATUScurrentDESCRIPTION"A unique value, greater than zero, for each
character port in the managed system. It is
recommended that values are assigned contiguously
starting from 1. The value for each interface sub-
layer must remain constant at least from one re-
initialization of the entity's network management
system to the next re-initialization.
In a system where the character ports are attached
to hardware represented by an ifIndex, it is
conventional, but not required, to make the
character port index equal to the corresponding
ifIndex."SYNTAXInteger32-- Generic Character information
charNumber OBJECT-TYPESYNTAXInteger32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The number of entries in charPortTable, regardless
of their current state."::={ char 1}-- the Character Port tablecharPortTable OBJECT-TYPESYNTAXSEQUENCEOF CharPortEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"A list of port entries. The number of entries is
given by the value of charNumber."::={ char 2}
charPortEntry OBJECT-TYPESYNTAX CharPortEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Status and parameter values for a character port."INDEX{ charPortIndex }::={ charPortTable 1}
CharPortEntry ::=SEQUENCE{
charPortIndex
PortIndex,
charPortName
DisplayString,
charPortType
INTEGER,
charPortHardware
AutonomousType,
charPortReset
INTEGER,
charPortAdminStatus
INTEGER,
charPortOperStatus
INTEGER,
charPortLastChange
TimeTicks,
charPortInFlowType
INTEGER,
charPortOutFlowType
INTEGER,
charPortInFlowState
INTEGER,
charPortOutFlowState
INTEGER,
charPortInCharacters
Counter32,
charPortOutCharacters
Counter32,
charPortAdminOrigin
INTEGER,
charPortSessionMaximum
INTEGER,
charPortSessionNumber
Gauge32,
charPortSessionIndex
INTEGER,
charPortInFlowTypes
OCTETSTRING,
charPortOutFlowTypes
OCTETSTRING,
charPortLowerIfIndex
InterfaceIndex}charPortIndex OBJECT-TYPESYNTAXPortIndexMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"A unique value for each character port, perhaps
corresponding to the same value of ifIndex when the
character port is associated with a hardware port
represented by an ifIndex."::={ charPortEntry 1}
charPortName OBJECT-TYPESYNTAXDisplayString(SIZE(0..32))MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"An administratively assigned name for the port,
typically with some local significance."::={ charPortEntry 2}charPortType OBJECT-TYPESYNTAXINTEGER{ physical(1), virtual(2)}MAX-ACCESSread-only
STATUScurrentDESCRIPTION"The port's type, 'physical' if the port represents
an external hardware connector, 'virtual' if it does
not."::={ charPortEntry 3}charPortHardware OBJECT-TYPESYNTAXAutonomousTypeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"A reference to hardware MIB definitions specific to
a physical port's external connector. For example,
if the connector is RS-232, then the value of this
object refers to a MIB sub-tree defining objects
specific to RS-232. If an agent is not configured
to have such values, the agent returns the object
identifier:
nullHardware OBJECT IDENTIFIER ::= { 0 0 }
"::={ charPortEntry 4}charPortReset OBJECT-TYPESYNTAXINTEGER{ ready(1), execute(2)}MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"A control to force the port into a clean, initial
state, both hardware and software, disconnecting all
the port's existing sessions. In response to a
get-request or get-next-request, the agent always
returns 'ready' as the value. Setting the value to
'execute' causes a reset."::={ charPortEntry 5}charPortAdminStatus OBJECT-TYPE
SYNTAXINTEGER{ enabled(1), disabled(2), off(3),maintenance(4)}MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"The port's desired state, independent of flow
control. 'enabled' indicates that the port is
allowed to pass characters and form new sessions.
'disabled' indicates that the port is allowed to
pass characters but not form new sessions. 'off'
indicates that the port is not allowed to pass
characters or have any sessions. 'maintenance'
indicates a maintenance mode, exclusive of normal
operation, such as running a test.
'enabled' corresponds to ifAdminStatus 'up'.
'disabled' and 'off' correspond to ifAdminStatus
'down'. 'maintenance' corresponds to ifAdminStatus
'test'."::={ charPortEntry 6}charPortOperStatus OBJECT-TYPESYNTAXINTEGER{ up(1), down(2),maintenance(3), absent(4), active(5)}MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The port's actual, operational state, independent
of flow control. 'up' indicates able to function
normally. 'down' indicates inability to function
for administrative or operational reasons.
'maintenance' indicates a maintenance mode,
exclusive of normal operation, such as running a
test. 'absent' indicates that port hardware is not
present. 'active' indicates up with a user present
(e.g. logged in).
'up' and 'active' correspond to ifOperStatus 'up'.
'down' and 'absent' correspond to ifOperStatus
'down'. 'maintenance' corresponds to ifOperStatus
'test'."::={ charPortEntry 7}charPortLastChange OBJECT-TYPESYNTAXTimeTicksMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of sysUpTime at the time the port entered
its current operational state. If the current state
was entered prior to the last reinitialization of
the local network management subsystem, then this
object contains a zero value."::={ charPortEntry 8}-- charPortInFlowType is deprecated in favor of-- charPortInFlowTypescharPortInFlowType OBJECT-TYPESYNTAXINTEGER{ none(1), xonXoff(2), hardware(3),ctsRts(4), dsrDtr(5)}MAX-ACCESSread-write
STATUSdeprecatedDESCRIPTION"The port's type of input flow control. 'none'
indicates no flow control at this level or below.
'xonXoff' indicates software flow control by
recognizing XON and XOFF characters. 'hardware'
indicates flow control delegated to the lower level,
for example a parallel port.
'ctsRts' and 'dsrDtr' are specific to RS-232-like
ports. Although not architecturally pure, they are
included here for simplicity's sake."::={ charPortEntry 9}-- charPortOutFlowType is deprecated in favor of-- charPortOutFlowTypescharPortOutFlowType OBJECT-TYPESYNTAXINTEGER{ none(1), xonXoff(2), hardware(3),
ctsRts(4), dsrDtr(5)}MAX-ACCESSread-writeSTATUSdeprecatedDESCRIPTION"The port's type of output flow control. 'none'
indicates no flow control at this level or below.
'xonXoff' indicates software flow control by
recognizing XON and XOFF characters. 'hardware'
indicates flow control delegated to the lower level,
for example a parallel port.
'ctsRts' and 'dsrDtr' are specific to RS-232-like
ports. Although not architecturally pure, they are
included here for simplicy's sake."::={ charPortEntry 10}
charPortInFlowState OBJECT-TYPESYNTAXINTEGER{ none(1), unknown(2), stop(3), go(4)}MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The current operational state of input flow control
on the port. 'none' indicates not applicable.
'unknown' indicates this level does not know.
'stop' indicates flow not allowed. 'go' indicates
flow allowed."::={ charPortEntry 11}charPortOutFlowState OBJECT-TYPE
SYNTAXINTEGER{ none(1), unknown(2), stop(3), go(4)}MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The current operational state of output flow
control on the port. 'none' indicates not
applicable. 'unknown' indicates this level does not
know. 'stop' indicates flow not allowed. 'go'
indicates flow allowed."::={ charPortEntry 12}charPortInCharacters OBJECT-TYPESYNTAXCounter32
MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Total number of characters detected as input from
the port since system re-initialization and while
the port operational state was 'up', 'active', or
'maintenance', including, for example, framing, flow
control (i.e. XON and XOFF), each occurrence of a
BREAK condition, locally-processed input, and input
sent to all sessions."::={ charPortEntry 13}charPortOutCharacters OBJECT-TYPESYNTAXCounter32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Total number of characters detected as output to
the port since system re-initialization and while
the port operational state was 'up', 'active', or
'maintenance', including, for example, framing, flow
control (i.e. XON and XOFF), each occurrence of a
BREAK condition, locally-created output, and output
received from all sessions."::={ charPortEntry 14}charPortAdminOrigin OBJECT-TYPESYNTAXINTEGER{ dynamic(1), network(2), local(3),none(4)}MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"The administratively allowed origin for
establishing session on the port. 'dynamic' allows
'network' or 'local' session establishment. 'none'
disallows session establishment."::={ charPortEntry 15}charPortSessionMaximum OBJECT-TYPESYNTAXINTEGER(-1..2147483647)MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"The maximum number of concurrent sessions allowed
on the port. A value of -1 indicates no maximum.
Setting the maximum to less than the current number
of sessions has unspecified results."::={ charPortEntry 16}charPortSessionNumber OBJECT-TYPE
SYNTAXGauge32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The number of open sessions on the port that are in
the connecting, connected, or disconnecting state."::={ charPortEntry 17}charPortSessionIndex OBJECT-TYPESYNTAXINTEGER(0..2147483647)MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of charSessIndex for the port's first or
only active session. If the port has no active
session, the agent returns the value zero."
::={ charPortEntry 18}charPortInFlowTypes OBJECT-TYPESYNTAXOCTETSTRING(SIZE(1))MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"The port's types of input flow control at the
software level. Hardware-level flow control is
independently controlled by the appropriate
hardware-level MIB.
A value of zero indicates no flow control.
Depending on the specific implementation, any or
all combinations of flow control may be chosen by
adding the values:
128 xonXoff, recognizing XON and XOFF characters
64 enqHost, ENQ/ACK to allow input to host
32 enqTerm, ACK to allow output to port
"::={ charPortEntry 19}charPortOutFlowTypes OBJECT-TYPESYNTAXOCTETSTRING(SIZE(1))MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"The port's types of output flow control at the
software level. Hardware-level flow control is
independently controlled by the appropriate
hardware-level MIB.
A value of zero indicates no flow control.
Depending on the specific implementation, any or
all combinations of flow control may be chosen by
adding the values:
128 xonXoff, recognizing XON and XOFF characters
64 enqHost, ENQ/ACK to allow input to host
32 enqTerm, ACK to allow output to port
"::={ charPortEntry 20}charPortLowerIfIndex OBJECT-TYPESYNTAXInterfaceIndexMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The ifIndex value of the lower level hardware supporting
this character port, zero if none."::={ charPortEntry 21}-- the Character Session tablecharSessTable OBJECT-TYPESYNTAXSEQUENCEOF CharSessEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION
"A list of port session entries."::={ char 3}charSessEntry OBJECT-TYPESYNTAX CharSessEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Status and parameter values for a character port
session."INDEX{ charSessPortIndex, charSessIndex }::={ charSessTable 1}
CharSessEntry ::=SEQUENCE{
charSessPortIndex
PortIndex,
charSessIndex
INTEGER,
charSessKill
INTEGER,
charSessState
INTEGER,
charSessProtocol
AutonomousType,
charSessOperOrigin
INTEGER,
charSessInCharacters
Counter32,
charSessOutCharacters
Counter32,
charSessConnectionId
InstancePointer,
charSessStartTime
TimeTicks}charSessPortIndex OBJECT-TYPESYNTAXPortIndexMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of charPortIndex for the port to which
this session belongs."::={ charSessEntry 1}charSessIndex OBJECT-TYPESYNTAXINTEGER(1..2147483647)MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The session index in the context of the port, a
non-zero positive integer. Session indexes within a
port need not be sequential. Session indexes may be
reused for different ports. For example, port 1 and
port 3 may both have a session 2 at the same time.
Session indexes may have any valid integer value,
with any meaning convenient to the agent
implementation."::={ charSessEntry 2}
charSessKill OBJECT-TYPESYNTAXINTEGER{ ready(1), execute(2)}MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"A control to terminate the session. In response to
a get-request or get-next-request, the agent always
returns 'ready' as the value. Setting the value to
'execute' causes termination."::={ charSessEntry 3}charSessState OBJECT-TYPESYNTAXINTEGER{ connecting(1), connected(2),
disconnecting(3)}MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The current operational state of the session,
disregarding flow control. 'connected' indicates
that character data could flow on the network side
of session. 'connecting' indicates moving from
nonexistent toward 'connected'. 'disconnecting'
indicates moving from 'connected' or 'connecting' to
nonexistent."::={ charSessEntry 4}charSessProtocol OBJECT-TYPESYNTAXAutonomousTypeMAX-ACCESSread-only
STATUScurrentDESCRIPTION"The network protocol over which the session is
running. Other OBJECT IDENTIFIER values may be
defined elsewhere, in association with specific
protocols. However, this document assigns those of
known interest as of this writing."::={ charSessEntry 5}wellKnownProtocols OBJECTIDENTIFIER::={ char 4}protocolOther OBJECTIDENTIFIER::={ wellKnownProtocols 1}protocolTelnet OBJECTIDENTIFIER::={ wellKnownProtocols 2}
protocolRlogin OBJECTIDENTIFIER::={ wellKnownProtocols 3}protocolLat OBJECTIDENTIFIER::={ wellKnownProtocols 4}protocolX29 OBJECTIDENTIFIER::={ wellKnownProtocols 5}protocolVtp OBJECTIDENTIFIER::={ wellKnownProtocols 6}charSessOperOrigin OBJECT-TYPESYNTAXINTEGER{ unknown(1), network(2), local(3)}
MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The session's source of establishment."::={ charSessEntry 6}charSessInCharacters OBJECT-TYPESYNTAXCounter32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"This session's subset of charPortInCharacters."::={ charSessEntry 7}charSessOutCharacters OBJECT-TYPESYNTAXCounter32
MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"This session's subset of charPortOutCharacters."::={ charSessEntry 8}charSessConnectionId OBJECT-TYPESYNTAXInstancePointerMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"A reference to additional local MIB information.
This should be the highest available related MIB,
corresponding to charSessProtocol, such as Telnet.
For example, the value for a TCP connection (in the
absence of a Telnet MIB) is the object identifier of
tcpConnState. If an agent is not configured to have
such values, the agent returns the object
identifier:
nullConnectionId OBJECT IDENTIFIER ::= { 0 0 }
"::={ charSessEntry 9}charSessStartTime OBJECT-TYPESYNTAXTimeTicksMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of sysUpTime in MIB-2 when the session
entered connecting state."::={ charSessEntry 10}-- conformance informationcharConformance OBJECTIDENTIFIER::={ char 5}charGroups OBJECTIDENTIFIER::={ charConformance 1}
charCompliances OBJECTIDENTIFIER::={ charConformance 2}-- compliance statementscharCompliance MODULE-COMPLIANCESTATUScurrentDESCRIPTION"The compliance statement for SNMPv2 entities
which have Character hardware interfaces."MODULE-- this moduleMANDATORY-GROUPS{ charGroup }::={ charCompliances 1}-- units of conformancecharGroup OBJECT-GROUPOBJECTS{ charNumber, charPortIndex, charPortName,
charPortType, charPortHardware, charPortReset,
charPortAdminStatus, charPortOperStatus,
charPortLastChange,
charPortInFlowState, charPortOutFlowState,
charPortAdminOrigin, charPortSessionMaximum,
charPortInFlowTypes, charPortOutFlowTypes,
charPortInCharacters, charPortOutCharacters,
charPortSessionNumber, charPortSessionIndex,
charPortLowerIfIndex,
charSessPortIndex, charSessIndex,
charSessKill, charSessState,
charSessProtocol, charSessOperOrigin,
charSessInCharacters, charSessOutCharacters,
charSessConnectionId, charSessStartTime }STATUScurrentDESCRIPTION"A collection of objects providing information
applicable to all Character interfaces."::={ charGroups 1}END